Fix #1474, #1552, Resolve API prototype/implementation discrepancies #1551
Conversation
skliper
added
the
CCB:Ready
|
CCB:2021-05-19 APPROVED
|
astrogeco
added
the
CCB:Approved
Changing the implementation return types to CFE_Status_t to match the function prototypes.
skliper
force-pushed
the
fix1474_prototype-scrub
branch
from
6006b8d
to
7e3effd
Compare
skliper
changed the title
|
Added in the ut-stub updates with 7e3effd |
There was a problem hiding this comment.
Note, going forward we should consider the names in the header/documentation to be part of the API. That is, a name change in the header is treated similarly to an API change like adding or removing an argument. That's because unit test hooks may now be referencing parameters by the names in the header/documentation.
So if/when in the future there are discrepancies found between header and implementation, it would be less impact (compatibility-wise) to update the implementation to match the header, rather than the header to match the implementation.
astrogeco
removed
the
CCB:Ready
|
@astrogeco I only changed the implementation to match the prototypes for #1474. No work was done on my part to complete #921, another issue was also mentioned to remove the |
|
@astrogeco The full set of commits does fix those issues as described and linked in the PR. |
skliper
force-pushed
the
fix1474_prototype-scrub
branch
from
7e3effd
to
da3f996
Compare
|
@astrogeco Amended the commit message on the last one since it alone fixed #1552, the first two together fixed #1474. |
astrogeco
changed the title
nasa/cFE#1551, fixes discrepancies (return type, parameter names, etc) between function protoypes and implementation. Updates stubs accordingly
Combines: - cfe v6.8.0-rc1+dev593 (nasa/cFE#1568) - osal v5.1.0-rc1+dev458 (nasa/osal#1050) Includes: - nasa/cFE#1524, add printf format casts - nasa/cFE#1520, accept "NULL" as entry point - nasa/cfe #1549, add capability to generate multiple tables - nasa/cFE#1551, fixes discrepancies (return type, parameter names, etc) between function protoypes and implementation. Updates stubs accordingly - nasa/osal#1026, Add count sem timeout test - nasa/osal#1026, defer cancellation when BSP locked
Describe the contribution
Fix #1474 - This checks prototypes against implementation and fixes any differences (return type, parameter names, etc). For the most part implementation was considered truth (fixed prototype) except for CFE_Status_t return type change. Also fixes some but not all use of CFE_Status_t in the implementations.
Fix #1552 - note completed ut-stub updates after CCB, added in since they are trival.
Follow on work needed - Internal use of CFE_Status_t (#921)
Testing performed
Built and ran unit tests, all passed. Built usersguide and confirmed no errors.
Expected behavior changes
None
System(s) tested on
Additional context
Builds on commit from @zachar1a submitted in #1531, now closed as duplicate to this PR
Third party code
None
Contributor Info - All information REQUIRED for consideration of pull request
Jacob Hageman - NASA/GSFC
Zachary Gonzalez - Individual